Add TypeScript Definitions #71
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
added 3 commits
August 25, 2020 15:23
Adds interface definitions for TypeScript to allow code to be used in TypeScript modules.
|
@kylegmaxwell, thanks for your contribution. Try it out in 4.1.0. |
|
I tried it out with 4.1.1 and it works great for our use case, thanks for accepting it and catching those documentation updates. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi, Thank you for the great library. I am trying to use satellite.js in TypeScript which requires type definitions for the TypeScript compiler. I got it working locally, but would like to share the definitions so others can use your library in TypeScript as well.
I followed the contribution directions, except that I had to fork instead of branch since I don't expect to have write access to your repository.
I also updated the change log and version as directed by the contributions guide, but if that is something that you prefer to mange I can remove that from this pull request.
I can also attach my test file which may help you see how this can be used in TypeScript with Jest. The test file is just for reference since I did not add TypeScript to your package dependencies, since that seemed like too much of a change.
satellite.test.ts.txt
Let me know what you think.
Thanks, Kyle